Typ złożony OrderListResponse

Opis

Rezultat przetworzenia operacji pobrania listy zleceń

Element opisujący strukturę rezultat przetworzenia operacji pobrania listy zleceń

Przestrzeń nazw

http://api.big.pl/bimoS/v1

Typ podstawowy

Extension of Typ złożony Response

Diagram

Przegląd

OrderListResponse Extension of Typ złożony Response

Rezultat przetworzenia operacji pobrania listy zleceń

Element opisujący strukturę rezultat przetworzenia operacji pobrania listy zleceń

Sequence

Choice

authorisationError Typ złożony AuthorisationError

Błąd autoryzacji

Błąd zwracany w wyniku braku uprawnień do przeprowadzenia operacji

Sequence

errorType Typ prosty authErrorTypeEnum

Typ błędu autoryzacji

Typ błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.

errorDescription Typ prosty string

Opis typu błędu autoryzacji

Opis typu błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.

requestError Typ złożony RequestError

Błąd walidacji

Błąd danych zapytania

Sequence

currentRequest optional Typ złożony Request

Bieżące żądanie

Dane dotyczące bieżącego komunikatu żądania (request).

Sequence

Choice

client Typ złożony Subscriber

Klient BIG IM przeprowadzający operację

Element, który zawiera identyfikatory Klienta zlecającego operację

proxy Typ złożony Proxy

Przedstawiciel Klienta

Identyfikatory Przedstawiciela klienta BIG IM, przeprowadzający operację w jego imieniu

validityDateTime optional Typ prosty dateTime

Data i czas aktualności danych

Wskazanie daty i czasu na który aktualne są przekazywane do BIG InfoMonitor dane. Domyślnie SIBIG przyjmuje, że przekazywane dane są aktualne na moment wywołania usługi BIG InfoMonitor przez system Subskrybenta.

operationType optional Typ prosty operationTypeEnum

Rodzaj operacji

Rodzaj operacji zleconej do wykonania.

validationError 1..∞ Typ złożony ValidationError

Błąd walidacji

Informacje dotyczące błędów walidacji, jakie wykrył SIBIG

Sequence

orderNumber Typ prosty int6

Numer kolejny błędu

Numer kolejny błędu walidacji wykrytego w komunikacie. Numeracja zaczyna się od „1”.

validationRuleId Typ prosty string32

Kod błędu

Kod błędu walidacji

message optional Typ prosty string

Opis błędu

Opis błędu walidacji

faultyElementPath optional Typ prosty string

XPath

XPath do błędnej ścieżki komunikatu

dependentElementPath optional Typ prosty string

Xpath do pola zależnego

Xpath do pola zależnego, względem pola, do którego zgłoszony został błąd (@ValidationError.faultyElementPath)

success Typ złożony SuccessResponse

Sukces

Pozytywny rezultat przetwarzania operacji (sukces)

orderList optional Typ złożony OrderList

Lista zleceń

Lista zleceń wygenerowania raportów administracyjnych

ordersNumber optional xs:int

Liczba zleceń

Sequence

order optional Typ złożony Order

Rekord zlecenia

Dane rekordu listy zleceń

orderId required Typ prosty string32

Identyfikator zlecenia

Identyfikator zlecenia nadany przez System

userId required Typ prosty string32

Identyfikator użytkownika

Identyfikator systemowy użytkownika, który zarejestrował zlecenie

Sequence

orderDate xs:dateTime

Data zarejestrowania zlecenia

orderStatus Typ prosty orderStatusEnum

Status zlecenia

Aktualny status zlecenia

orderSubject optional Typ złożony OrderSubject

Przedmiot zlecenia

Przedmiot zarejestrowanego zlecenia. Zlecona paczka operacji nie jest zwracana w operacjach dotyczących statusu przetwarzania paczki.

orderProcessingSummary optional Typ złożony OrderProcessingSummary

Podsumowanie stanu zlecenia

Podsumowanie informacji na temat przetworzenia zlecenia

orderResult optional Typ złożony OrderResult

Rezultat przetworzenia zlecenia

Używany przez

Element getOrderListResponse

Źródło

<xs:complexType name="OrderListResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Rezultat przetworzenia operacji pobrania listy zleceń</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Element opisujący strukturę rezultat przetworzenia operacji pobrania listy zleceń</div>
    </xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="bs:Response">
      <xs:sequence>
        <xs:element name="orderList" type="bs:OrderList" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Lista zleceń</div>
              <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Lista zleceń wygenerowania raportów administracyjnych</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Zobacz także

Schema bimoS.v1